home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #4 / Amiga Plus CD - 2000 - No. 4.iso / Tools / Dev / Bgui / AutoDoc / pageclass.doc < prev    next >
Encoding:
Text File  |  2000-05-09  |  6.9 KB  |  300 lines
  1. TABLE OF CONTENTS
  2.  
  3. pageclass/--background--
  4. pageclass/GRM_ADDMEMBER
  5. pageclass/GRM_INSERTMEMBER
  6. pageclass/GRM_REMMEMBER
  7. pageclass/GRM_REPLACEMEMBER
  8. pageclass/GRM_WHICHOBJECT
  9. pageclass/OM_DISPOSE
  10. pageclass/PAGE_Active
  11. pageclass/PAGE_Inverted
  12. pageclass/PAGE_Member
  13. pageclass/PAGE_NoBufferRP
  14.  
  15. pageclass/--background--
  16.  
  17. NAME
  18.  
  19.   Class: pageclass
  20.   Superclass: baseclass
  21.   Include File: <libraries/bgui.h>
  22.  
  23. FUNCTION
  24.  
  25.   To provide a gadget which can keep track of "pages" of gadgets of
  26.   which one is displayed at a time. The pages can contain a groupclass
  27.   object which has a set of members or it can contain a single gadget.
  28.  
  29.   Objects from this class send out the following attribute pairs in
  30.   their notification events:
  31.  
  32.   PAGE_Active - Currently active page number.
  33.  
  34. pageclass/GRM_ADDMEMBER
  35.  
  36.     NAME
  37.     GRM_ADDMEMBER -- Add a object to a page group.
  38.  
  39.     SYNOPSIS
  40.     err = DoMethod( obj, GRM_ADDMEMBER, member, tag, data, ... );
  41.  
  42.     ULONG        err;
  43.     Object           *member;
  44.     Tag        tag;
  45.     ULONG        data;
  46.  
  47.     FUNCTION
  48.     This method can be used to add a member to an existing page group.
  49.  
  50.     INPUTS
  51.     member     - A pointer to the object which you want to add to the group.
  52.     tag,data - This is simply a tagitem array  terminated  by a  TAG_DONE.
  53.            The following attributes are possible:
  54.  
  55.            LGO_Relayout -- Normally the group is layed-out again if adding the
  56.             new member to the group succeeds.  Setting this tag to FALSE prevents
  57.             this so you may do that later calling GRM_RELAYOUT explicitly.
  58.  
  59.     RESULT
  60.     err    - TRUE uppon success, FALSE uppon failure.
  61.  
  62.     If this method was successfull you do not need to dispose  of the added
  63.     member anymore. This will be disposed of as soon as the group  to which
  64.     the member was added is disposed of.
  65.  
  66.     SEE ALSO
  67.     GRM_INSERTMEMBER, GRM_REMMEMBER, GRM_REPLACEMEMBER
  68.  
  69. pageclass/GRM_INSERTMEMBER
  70.  
  71.     NAME
  72.     GRM_INSERTMEMBER -- Insert a member behind an existing member.
  73.  
  74.     SYNOPSIS
  75.     err = DoMethod( obj, GRM_INSERTMEMBER, member, pred, tag, data, ... );
  76.  
  77.     ULONG         err;
  78.     Object        *member;
  79.     Object        *pred;
  80.     Tag         tag;
  81.     ULONG         data;
  82.  
  83.     FUNCTION
  84.     This method is basically the same as GRM_ADDMEMBER with the  exception
  85.     that you can determine the object after which the object is added.
  86.  
  87.     INPUTS
  88.     member    - A pointer to the object to insert.
  89.     pred    - This must point to  the object  after  which the  new member
  90.         is inserted.  You may set this to  NULL in which case  the new
  91.         member is inserted at the start of the list.
  92.     tag,data - Here  you  can  pass  a  set  of  tagitems  in which layout
  93.         specific attributes can  be  defined.    Please    refer  to  the
  94.         GRM_ADDMEMBER section for more    information  on  the available
  95.         attributes.
  96.  
  97.     RESULT
  98.     err - TRUE uppon success, FALSE uppon failure.
  99.  
  100.     If this method was successful you do not need to dispose of the added
  101.     member anymore. This will be disposed of as soon as the group to which
  102.     the member was added is disposed of.
  103.  
  104.     SEE ALSO
  105.     GRM_ADDMEMBER, GRM_REMMEMBER, GRM_REPLACEMEMBER
  106.  
  107. pageclass/GRM_REMMEMBER
  108.  
  109.     NAME
  110.     GRM_REMMEMBER -- Remove an object from the group.
  111.  
  112.     SYNOPSIS
  113.     DoMethod( obj, GRM_REMMEMBER, member );
  114.  
  115.     Object        *member;
  116.  
  117.     FUNCTION
  118.     To remove  an  object  previously  added  create time or with the
  119.     GRM_ADDMEMBER, GRM_INSERTMEMBER, GRM_REPLACEMEMBER, methods.
  120.  
  121.     INPUTS
  122.     member    - A pointer to the object which is  to    be  removed  from the
  123.         group.
  124.  
  125.     RESULT
  126.     No return code specified.
  127.  
  128.     NOTE
  129.     After  the  object has been removed you are responsible for disposing
  130.     of the removed object.
  131.  
  132.     SEE ALSO
  133.     GRM_ADDMEMBER, GRM_INSERTMEMBER, GRM_REPLACEMEMBER, intuition.library/DisposeObject()
  134.  
  135. pageclass/GRM_REPLACEMEMBER
  136.  
  137.     NAME
  138.     GRM_REPLACEMEMBER -- Replace an object with another.
  139.  
  140.     SYNOPSIS
  141.     rep = DoMethod( obj, GRM_REPLACEMEMBER, rem, add, tag, data, ... )
  142.  
  143.     Object        *rep;
  144.     Object        *rem;
  145.     Object        *add;
  146.     Tag         tag;
  147.     ULONG         data;
  148.  
  149.     FUNCTION
  150.     This method can be used to replace a member of a group    with  another
  151.     member.
  152.  
  153.     INPUTS
  154.     rem    - This should point to the object which is to be replaced.
  155.     add    - This should point to the object which  is  to  replace  the
  156.         object described in "rem".
  157.     tag,data - This  is  an array of attributes which control the way the
  158.         new object is layouted.   The  attributes  allowed  here  are
  159.         exactly the same as  the  attributes  you  can    use  with the
  160.         GRM_ADDMEMBER method.
  161.  
  162.     RESULT
  163.     rep    - A pointer to the replaced object  uppon  success,  and  NULL
  164.         uppon failure.
  165.  
  166.     If  this  method  was  successful  you    do not    need to dispose of the
  167.     member which replaces the other member anymore.  This will be disposed
  168.     of as soon as the group to which  the member was added is disposed of.
  169.  
  170.     You are however responsible to dispose    of  the  object which you have
  171.     replaced.
  172.  
  173.     SEE ALSO
  174.     GRM_ADDMEMBER, GRM_INSERTMEMBER, GRM_REMMEMBER
  175.  
  176. pageclass/GRM_WHICHOBJECT
  177.  
  178.     NAME
  179.     GRM_WHICHOBJECT -- Find the object at the specified coordinates.
  180.  
  181.     SYNOPSIS
  182.     obj = DoMethod( obj, GRM_WHICHOBJECT, xy );
  183.  
  184.     Object        *obj;
  185.     ULONG         xy;
  186.  
  187.     FUNCTION
  188.     This method  should  be  used  to  find  out which object  is  located
  189.     under  the  given  X/Y coordinates.
  190.  
  191.     INPUTS
  192.     xy    - A 32bit  unsigned  integer  which   holds   the   horizontal
  193.         coordinate in the upper 16 bits  and the  vertical  coordinate
  194.         in the lower 16 bits. The coordinates  should  be  relative to
  195.         the upper-left corner of the window.
  196.  
  197.     NOTE
  198.     Please    note  that this method will only work properly when the window
  199.     in which the page group is located is open.
  200.  
  201.     This method is primarily used for the tool tips but may also be useful
  202.     for the application programmer.
  203.  
  204.     RESULT
  205.     Returns the object under the coordinates or NULL if there is no object
  206.     under the given coordinates.
  207.  
  208. pageclass/OM_DISPOSE
  209.  
  210. NAME
  211.  
  212.   OM_DISPOSE
  213.  
  214. FUNCTION
  215.  
  216.   When this method is called it will also dispose of all
  217.   pages of objects attached to this object.
  218.  
  219.  
  220. pageclass/PAGE_Active
  221.  
  222. NAME
  223.  
  224.   PAGE_Active -- ( ULONG )
  225.  
  226. FUNCTION
  227.  
  228.   Set the page number currently active (I.E. displayed on the window).
  229.   The active page is the only page that can receive input.
  230.  
  231. DEFAULT
  232.  
  233.   0.
  234.  
  235. APPLICABILITY
  236.  
  237.   (ISGNU).
  238.  
  239. pageclass/PAGE_Inverted
  240.  
  241. NAME
  242.  
  243.   PAGE_Inverted -- ( BOOL )
  244.  
  245. FUNCTION
  246.  
  247.   To force the members added at create time to be AddHead()'ed to the
  248.   member list instead of AddTail()'ed. This is necessary for the
  249.   assembly macros of the BGUI package.
  250.  
  251. DEFAULT
  252.  
  253.   FALSE.
  254.  
  255. APPLICABILITY
  256.  
  257.   (I).
  258.  
  259. pageclass/PAGE_Member
  260.  
  261. NAME
  262.  
  263.   PAGE_Member -- ( Object * )
  264.  
  265. FUNCTION
  266.  
  267.   To add a page of gadgets. The object may be a groupclass object having
  268.   any number of members or it may be a single gadget object.
  269.  
  270. DEFAULT
  271.  
  272.   NULL.
  273.  
  274. APPLICABILITY
  275.  
  276.   (I).
  277.  
  278. pageclass/PAGE_NoBufferRP
  279.  
  280. NAME
  281.  
  282.   PAGE_NoBufferRP -- ( BOOL )
  283.  
  284. FUNCTION
  285.  
  286.   When this attribute is set to TRUE the pageclass will tell the
  287.   layout engine not to setup a buffer RastPort which means that all
  288.   rendering occurs on-screen. This may be handy when you use objects
  289.   which take some time to render like the colorwheel.gadget on 256
  290.   colour screens.
  291.  
  292. DEFAULT
  293.  
  294.   FALSE.
  295.  
  296. APPLICABILITY
  297.  
  298.   (I).
  299.  
  300.